Global Index
HTML5 JS API Index > Indexed DB Tutorials & Specs

IDBIndex

Properties
any
keyPath
On getting, returns a value representing the key path of this index. If the key path is a DOMString, the value will be a DOMString equal to the key path. If the key path is a sequence<DOMString>, the value will be a new Array, populated by appending Strings equal to each DOMString in the sequence.
boolean
multiEntry
On getting, provide the multiEntry flag of this index.
DOMString
name
On getting, provide the name of this index.
IDBObjectStore
objectStore
On getting, returns a reference to the IDBObjectStore instance for the referenced object store in this IDBIndex's transaction. This MUST return the same IDBObjectStore instance as was used to get a reference to this IDBIndex.
boolean
unique
On getting, provide the unique flag of this index.
Operations
IDBRequest
count(optional any key)
If the transaction this IDBIndex belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the index or the index's object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
IDBRequest
get(any key)
If the transaction this IDBIndex belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the index or the index's object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
IDBRequest
getKey(any key)
Gets the key of the record from the referenced object store entry.
IDBRequest
openCursor(optional any? range, optional IDBCursorDirection direction)
If the transaction this IDBIndex belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the index or the index's object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
IDBRequest
openKeyCursor(optional any? range, optional IDBCursorDirection direction)
If the transaction this IDBIndex belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the index or the index's object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
Referenced by
IDBCursorsource
IDBObjectStoreindex(...)
IDBRequestsource